<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:16 CEST 2016 -->
    <title>CommandBuilder (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="CommandBuilder (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/shell/command/CommandBuilder" target="_top">Frames</a></li>
            <li><a href="CommandBuilder.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.shell.command</strong></div>

    <h2 title="[Groovy] Class CommandBuilder" class="title">[Groovy] Class CommandBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.shell.command.CommandBuilder
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">



    <p> A build for Vert.x Shell command.
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#CommandBuilder(java.lang.Object)">CommandBuilder</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/command/Command.html'>Command</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#build(io.vertx.groovy.core.Vertx)">build</a></strong>(<a href='../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</code><br>Build the command</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#command(java.lang.String)">command</a></strong>(java.lang.String name)</code><br>Create a new commmand builder, the command is responsible for managing the options and arguments via the
 <a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandProcess.html' title='#args() arguments'>#args() arguments</a>.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#command(io.vertx.groovy.core.cli.CLI)">command</a></strong>(<a href='../../../../../../io/vertx/groovy/core/cli/CLI.html'>CLI</a> cli)</code><br>Create a new commmand with its <a href='../../../../../../io/vertx/groovy/core/cli/CLI.html' title='CLI'>CLI</a> descriptor. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#completionHandler(Handler<Completion>)">completionHandler</a></strong>(io.vertx.core.Handler&lt;Completion&gt; handler)</code><br>Set the command completion handler, the completion handler when the user asks for contextual command line
 completion, usually hitting the <i>tab</i> key.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#processHandler(Handler<CommandProcess>)">processHandler</a></strong>(io.vertx.core.Handler&lt;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandProcess.html' title='CommandProcess'>CommandProcess</a>&gt; handler)</code><br>Set the command process handler, the process handler is called when the command is executed.</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="CommandBuilder(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>CommandBuilder</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="build(io.vertx.groovy.core.Vertx)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/command/Command.html'>Command</a> <strong>build</strong>(<a href='../../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</h4>
                                <p> Build the command
   <DL><DT><B>Returns:</B></DT><DD>the built command</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>vertx</code> -  the vertx instance</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="command(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a> <strong>command</strong>(java.lang.String name)</h4>
                                <p> Create a new commmand builder, the command is responsible for managing the options and arguments via the
 <a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandProcess.html' title='#args() arguments'>#args() arguments</a>.
   <DL><DT><B>Returns:</B></DT><DD>the command</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>name</code> -  the command name</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="command(io.vertx.groovy.core.cli.CLI)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a> <strong>command</strong>(<a href='../../../../../../io/vertx/groovy/core/cli/CLI.html'>CLI</a> cli)</h4>
                                <p> Create a new commmand with its <a href='../../../../../../io/vertx/groovy/core/cli/CLI.html' title='CLI'>CLI</a> descriptor. This command can then retrieve the parsed
 <a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandProcess.html#commandLine' title='CommandProcess.commandLine'>CommandProcess.commandLine</a> when it executes to know get the command arguments and options.
   <DL><DT><B>Returns:</B></DT><DD>the command</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>cli</code> -  the cli to use</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="completionHandler(Handler<Completion>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a> <strong>completionHandler</strong>(io.vertx.core.Handler&lt;Completion&gt; handler)</h4>
                                <p> Set the command completion handler, the completion handler when the user asks for contextual command line
 completion, usually hitting the <i>tab</i> key.
   <DL><DT><B>Returns:</B></DT><DD>this command object</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>handler</code> -  the completion handler</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="processHandler(Handler<CommandProcess>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandBuilder.html'>CommandBuilder</a> <strong>processHandler</strong>(io.vertx.core.Handler&lt;<a href='../../../../../../io/vertx/groovy/ext/shell/command/CommandProcess.html' title='CommandProcess'>CommandProcess</a>&gt; handler)</h4>
                                <p> Set the command process handler, the process handler is called when the command is executed.
   <DL><DT><B>Returns:</B></DT><DD>this command object</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>handler</code> -  the process handler</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/shell/command/CommandBuilder" target="_top">Frames</a></li>
            <li><a href="CommandBuilder.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>